Vcenter Credential

The Vcenter Credential provides credential for authentication such as username/password or SAML token.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "type": "string",
    "username_password": {
        "user_name": "string",
        "password": "string"
    },
    "saml_token": "string"
}

string

type

Required

The type of credential to use for connecting to a VC.

For more information see: Vcenter Credential Type.

This property was added in vSphere API 9.0.0.0.

username_password

Optional

Username-password details.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of type is Vcenter Credential Type.USERNAME_PASSWORD.

string As password As password

saml_token

Optional

SAML token details, when using SAML based authentication.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of type is Vcenter Credential Type.SAML_TOKEN.